docs(charts): add matomo and clickhouse docs#368
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughAdds ClickHouse and Matomo chart entries to the charts registry, navigation categories, and playground sync configuration, along with dedicated playground field configurations and chart documentation pages for each chart. ChangesClickHouse and Matomo chart additions
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
src/pages/playground.astro (1)
58-59: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueOut-of-order insertion in
siteSyncPlaygroundConfigs.The map is otherwise alphabetically sorted;
clickhouseandmatomoare inserted afterlangflowinstead of in their alphabetical positions (beforecloudflaredanddolibarrrespectively).♻️ Suggested reordering
- langflow: 'src/data/playground-configs.ts', - clickhouse: 'src/data/playground-configs.ts', - matomo: 'src/data/playground-configs.ts', + clickhouse: 'src/data/playground-configs.ts', + ... + langflow: 'src/data/playground-configs.ts', + ... + matomo: 'src/data/playground-configs.ts',🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/pages/playground.astro` around lines 58 - 59, The siteSyncPlaygroundConfigs map is no longer alphabetically ordered because the clickhouse and matomo entries were inserted in the wrong positions. Reorder these entries within the siteSyncPlaygroundConfigs object in playground.astro so clickhouse appears before cloudflared and matomo appears before dolibarr, keeping the rest of the map sorted consistently.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/pages/docs/charts/clickhouse.mdx`:
- Around line 82-87: The ClickHouse values reference table is missing settings
that are already used in the docs examples. Update the values table near the
ClickHouse configuration section to include clickhouse.existingSecretPasswordKey
and clickhouse.defaultAccessManagement, matching the usage shown in the
Installation/Production/Auth/External Secrets examples and the Production Values
example. Keep the entries aligned with the existing ClickHouse keys so readers
can discover all required companion options in the same reference table.
In `@src/pages/docs/charts/matomo.mdx`:
- Around line 257-274: The values table in the Matomo docs is missing the
documented `matomo.trustedHost` setting, even though it is referenced in the
examples and Common Issues guidance. Update the parameters table in `matomo.mdx`
to add `matomo.trustedHost` with its default and a brief description, keeping it
aligned with the existing `matomo.siteUrl` entry and the related deployment
examples.
---
Nitpick comments:
In `@src/pages/playground.astro`:
- Around line 58-59: The siteSyncPlaygroundConfigs map is no longer
alphabetically ordered because the clickhouse and matomo entries were inserted
in the wrong positions. Reorder these entries within the
siteSyncPlaygroundConfigs object in playground.astro so clickhouse appears
before cloudflared and matomo appears before dolibarr, keeping the rest of the
map sorted consistently.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: e9677c09-54b9-482b-bd60-ac23b6e0f033
⛔ Files ignored due to path filters (13)
public/icons/charts/alfio.pngis excluded by!**/*.pngpublic/icons/charts/booklore.pngis excluded by!**/*.pngpublic/icons/charts/clickhouse.pngis excluded by!**/*.pngpublic/icons/charts/cronicle.pngis excluded by!**/*.pngpublic/icons/charts/dolibarr.pngis excluded by!**/*.pngpublic/icons/charts/fastmcp-server.pngis excluded by!**/*.pngpublic/icons/charts/ghost.pngis excluded by!**/*.pngpublic/icons/charts/kafka.pngis excluded by!**/*.pngpublic/icons/charts/matomo.pngis excluded by!**/*.pngpublic/icons/charts/metabase.pngis excluded by!**/*.pngpublic/icons/charts/ntfy.pngis excluded by!**/*.pngpublic/icons/charts/strava-statistics.pngis excluded by!**/*.pngpublic/icons/charts/umami.pngis excluded by!**/*.png
📒 Files selected for processing (6)
src/data/charts.tssrc/data/navigation.tssrc/data/playground-configs.tssrc/pages/docs/charts/clickhouse.mdxsrc/pages/docs/charts/matomo.mdxsrc/pages/playground.astro
## Summary - Adds a production-ready Matomo chart using the official `docker.io/library/matomo:5.11.2-apache` image. - Adds a production-safe standalone ClickHouse chart using the official `docker.io/clickhouse/clickhouse-server:25.8.28.1` image. - Includes values schemas, README/DESIGN/docs, examples, CI values, helm-unittest coverage, External Secrets, NetworkPolicy, dual-stack, ServiceMonitor where applicable, and operational guardrails. ## Issues Resolves #654. Resolves #705. ## Companion PRs - Site PR: helmforgedev/site#368 - Org profile PR: helmforgedev/.github#13 ## Validation Chart image verification: - `make image-verify IMAGE=docker.io/library/matomo:5.11.2-apache` - `make image-verify IMAGE=docker.io/clickhouse/clickhouse-server:25.8.28.1` Matomo: - `make validate-chart CHART=matomo` -> `matomo: FULLY VALIDATED (18 layers)` - Includes k3d behavioral validation for default, default-values, dual-stack, external-db, external-secrets, gateway-api, ingress, network-policy, and production scenarios. - Kubescape Security Scan: MITRE + NSA + SOC2 score 84.78%, 0 critical failed resources. ClickHouse: - `make validate-chart CHART=clickhouse` -> `clickhouse: FULLY VALIDATED (18 layers)` - Includes k3d behavioral validation for default, auth, default-values, dual-stack, ephemeral, external-secrets, metrics, network-policy, and production scenarios. - Kubescape Security Scan: MITRE + NSA + SOC2 score 89.39%, 0 critical failed resources. Repository gates: - `make preflight` - `make standards-check CHART=matomo` - `make standards-check CHART=clickhouse` - `node scripts/charts/template-standards-check.js --chart matomo` - `node scripts/charts/template-standards-check.js --chart clickhouse` - `make deps-check CHART=matomo` - `make deps-check CHART=clickhouse` - Markdown lint for new chart docs - `make site-sync-check CHART=matomo` - `make site-sync-check CHART=clickhouse` - `make org-check` ## Notes ClickHouse intentionally blocks `replicaCount > 1`; replicated or sharded deployments should use ClickHouse Operator or Altinity operator workflows. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added two new Helm charts: **ClickHouse** and **Matomo**, with standalone defaults, health/connection test hooks, and ready-to-use examples. * Included persistence, optional **ServiceMonitor** metrics, **NetworkPolicy** support, and **External Secrets**-based credential provisioning (plus MySQL/external DB + archiver support for Matomo). * **Documentation** * Added production, observability/metrics, external secrets, and networking guides, plus values schema validation for both charts. * **Tests** * Added Helm/unit rendering tests for metrics, network policies, secrets, PodDisruptionBudget behavior, connection checks, validation failures, and archiver security/behavior. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: MergeCheck <mergecheck@example.invalid>
## Summary - Updates the organization profile chart count from 87 to 89. - Keeps the profile aligned with the new Matomo and ClickHouse charts. ## Validation - make release-check REPO=.github - make attribution-check REPO=.github - make md-lint REPO=.github - make org-check Companion charts PR: helmforgedev/charts#706. Companion site PR: helmforgedev/site#368.
Summary
Validation
Companion charts PR: helmforgedev/charts#706.
Companion profile PR: helmforgedev/.github#13.
Summary by CodeRabbit
New Features
Documentation